home *** CD-ROM | disk | FTP | other *** search
/ Atari Mega Archive 1 / Atari Mega Archive - Volume 1.iso / editors / proed.lzh / PROED.DOC < prev    next >
Text File  |  1985-11-20  |  56KB  |  1,679 lines
  1. PRO-ED
  2. Cole Software
  3.  
  4.  
  5.  
  6.  
  7.            Thank you for down loading this copy of PRO-ED. I hope
  8.            you will find this program useful in your future
  9.            development work.
  10.  
  11.            PRO-ED is distributed free of charge, for you to use
  12.            as long as you wish. All I ask in return, is for you to
  13.            send me $15.00 to become a registered user of this program.
  14.            To register, send your name, address, phone and software
  15.            interest to the address listed below. It will surely be
  16.            appreciated.
  17.  
  18.            As a regisitered user, updates of this program will be made
  19.            available to you from time to time and you'll be able to make
  20.            suggestions for improving this program.
  21.  
  22.            Considerable time was spent in testing this computer
  23.            program and all the program's features should work
  24.            properly. However, no testing procedure is perfect and
  25.            should a "bug" be detected in this program, please
  26.            notify Cole Software in writing at the address listed
  27.            on the bottom of this page,
  28.  
  29.            Enhancements to PRO-ED are planned and your input into
  30.            the enhancement process is encouraged. Send all comments
  31.            and suggestions to the address listed below.
  32.  
  33.  
  34.            COPYRIGHT 1986 - Cole Software
  35.            PRO-ED is the unpublished work of Jerry Cole,
  36.            Cole Software, Beavercreek, Oregon and represents the
  37.            considerable time and effort spent in it's development.
  38.            You are allowed duplicate this program and to distribute
  39.            it to anyone you wish, but it MAY NOT BE SOLD in any form
  40.            without the written consent of it's author.
  41.            This notice MUST be included with all copies of this program.
  42.  
  43.  
  44.            Jerry Cole
  45.            P.O. BOX 95
  46.            Beavercreek, Oregon
  47.            97004-0095
  48.  
  49.            Phone: 503-632-4927
  50.  
  51. PRO-ED
  52. Cole Software
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.                    Table of Contents
  63.           ===========================================
  64.  
  65.           An Overview of PRO-ED...............Page  1
  66.  
  67.           How to use PRO-ED...................Page  2
  68.  
  69.             Responding to prompts
  70.             Loading a file to edit
  71.             Creating a new file
  72.             Basic editing
  73.             File insert
  74.             Starting a second edit
  75.             Saving your work
  76.             Aborting an editing session
  77.             Exiting the editor
  78.  
  79.           Explanation of Commands.............Page  9
  80.  
  81.             Complete command list
  82.             Function key commands
  83.             Control key commands
  84.             Alternate key commands
  85.             Extended commands
  86.  
  87.           Special Features....................Page 20
  88.  
  89.             Showing a Directory List
  90.             Undo Delete command
  91.             Entering control codes
  92.             Setting Tabs
  93.             Keyword Definitions
  94.             Outline Display mode
  95.             Profiles
  96.             Editor profile options
  97.  
  98.           Error and Warning Messages..........Page 25
  99.  
  100.           Index...............................Page 28
  101.  
  102.  
  103. PRO-ED                                     Page  1
  104. Cole Software
  105.  
  106.  
  107.  
  108.     PRO-ED an Overview
  109.     ==================
  110.  
  111.  
  112.     PRO-ED is a text editor designed specifically for the
  113.     programmer to create and edit source code. This editor can be
  114.     used to produce any type of document, but it does not attempt
  115.     to replace a word processor.
  116.  
  117.     The needs of a programmer developing source code programs are
  118.     quite different from a person writing a business letter, short
  119.     story or magazine article. The programmer should have a tool
  120.     that will assist him or her in being more productive, and in
  121.     making the task of development much easier.
  122.  
  123.     This editor is probably different from other programming editors
  124.     that you may have used previously. The major difference is how
  125.     PRO-ED works with text. PRO-ED presents you with a window into
  126.     your text file. This window is always 80 columns wide no matter
  127.     how short your lines are. No, each line does not take up 80
  128.     bytes of memory, but this editor is designed to give you that
  129.     impression.
  130.  
  131.     Speaking of 80 columns, this editor will strictly enforce an 80
  132.     column limit on line length. It is the opinion of many, that
  133.     source code should not exceed column 80, as longer lines may
  134.     affect readability.
  135.  
  136.     Before using this editor take a little time to review this
  137.     documentation. Explanations of all commands and special features
  138.     are found on the following pages.
  139.  
  140.  
  141. PRO-ED                                     Page  2
  142. Cole Software
  143.  
  144.                  How to use PRO-ED
  145.                  =================
  146.  
  147. Getting Started
  148. ---------------
  149.  
  150.     First of all it is a good idea to make a copy PRO-ED to another
  151.     disk before using the editor. Use the backup copy as your
  152.     working disk and place the master disk in safe place to insure
  153.     you will always have a good copy of the editor. PRO-ED will run
  154.     from RAM disk and hard disk without any problems.
  155.  
  156.     PRO-ED comes to you as a .TTP (Tos Takes Parms) program. This
  157.     will allow you to specify a pathname of a file to edit when
  158.     executing PRO-ED. If you are working in a shell environment,
  159.     PRO-ED will accept a pathname from the command line.
  160.  
  161. Responding to Prompts
  162. ---------------------
  163.  
  164.     On occasion the editor will prompt you for addition information
  165.     needed to carry out a command, such as filename, search string, etc.
  166.     The following editing keys will work when responding to a prompt:
  167.  
  168.     Backspace.......Deletes the character left of the cursor
  169.     Delete..........Deletes character under cursor
  170.     Insert..........Toggles between insert and overstrike modes
  171.     Tab.............Erases entry from cursor position / terminates entry
  172.     Clr/Home........Erases entire entry, positions cursor at beginning
  173.     Cursor Keys.....Moves cursor left and right in the entry
  174.     Return..........Terminates entry, full entry accepted
  175.  
  176. Loading a File to Edit
  177. ----------------------
  178.  
  179.     If a pathname was entered when executing PRO-ED, the program
  180.     will attempt to load that file into memory for editing. If not,
  181.     PRO-ED will prompt you for the pathname of a file to edit.
  182.     If the file cannot be found, "-- File Not Found --" will be
  183.     displayed, indicating that the editor could not locate the file
  184.     requested.
  185.  
  186.     PRO-ED will automatically remove and expand all tabs within the
  187.     file being loaded. Expansion is done on mod-8 boundaries. Also,
  188.     any lines terminating with LF's only will be changed to end with
  189.     CR/LF's.
  190.  
  191.     A list of files from a disk or directory can be shown on the
  192.     screen at any pathname prompt by entering a pathname containing
  193.     wild card characters.(See Special Features for more information)
  194.  
  195. Creating a New File
  196. -------------------
  197.  
  198.     To create a new file simply press the RETURN key at the pathname
  199.     prompt without entering a pathname. PRO-ED will request a pathname
  200.     when you save the file. A new file is indicated by the words
  201.     "New File" displayed on the left hand side of the status line.
  202.  
  203. PRO-ED                                     Page  3
  204. Cole Software
  205.  
  206.  
  207.  
  208.                  How to use PRO-ED
  209.                  =================
  210.  
  211.  
  212.  
  213. Basic Editing - The Status Line
  214. -------------------------------
  215.  
  216.     After loading a file or creating a new file the editor will
  217.     display the first screen of text and position the cursor on
  218.     column 1 of the first line. The top line of the screen is
  219.     reserved for the status line which is explained below.
  220.  
  221.  
  222.     File Being Edited      Line.  1  Col. 1t  ----- Options On -----
  223.     ^^^^^^^^^^^^^^^^^      ^^^^^^^^  ^^^^^^^  ^^^^^^^^^^^^^^^^^^^^^^
  224.     |            |      |           |
  225.     Filename being Edited    |      Column Cursor       |
  226.     is shown here        |      is on. 't'          |
  227.                 |      indicates TAB       |
  228.                 |               |
  229.                Line of File        Editor Options in effect
  230.                Cursor is on        ------------------------
  231.                            Outline Word-Wrap Indent
  232.                            Compose Insert     Control
  233.  
  234. Editor Options
  235. --------------
  236.  
  237.     Outline Mode      -- Condensed text display.
  238.               -- Toggled on and off with F6 function key
  239.  
  240.     Word Wrap Mode      -- Wraps word when cursor reaches column 80
  241.               -- Toggled on and off with F7 function key
  242.  
  243.     Auto Indent Mode  -- Cursor will indent to previous line on
  244.               -- line inserts, word wrap, and split line
  245.               -- Toggled on and off with F8 function key
  246.  
  247.     Compose Mode      -- Will insert a new line each time the
  248.               -- RETURN key is pressed
  249.               -- Toggled on and off with